Add support for DDL generation/migrations by alex-clickhouse · Pull Request #9 · ClickHouse/ClickHouse.EntityFrameworkCore

alex-clickhouse · 2026-04-10T13:53:58Z

No description provided.

codecov · 2026-04-10T13:55:06Z

Codecov Report

❌ Patch coverage is 85.84299% with 110 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
...use/Migrations/ClickHouseMigrationsSqlGenerator.cs	88.88%	16 Missing and 19 partials ⚠️
...sign/Internal/ClickHouseAnnotationCodeGenerator.cs	0.00%	14 Missing ⚠️
...ckHouse/Design/Internal/ClickHouseCodeGenerator.cs	0.00%	11 Missing ⚠️
.../Metadata/Internal/ClickHouseAnnotationProvider.cs	71.42%	4 Missing and 4 partials ⚠️
...nfrastructure/Internal/ClickHouseModelValidator.cs	88.88%	4 Missing and 3 partials ⚠️
...se/Design/Internal/ClickHouseDesignTimeServices.cs	0.00%	6 Missing ⚠️
.../Extensions/ClickHousePropertyBuilderExtensions.cs	50.00%	6 Missing ⚠️
...House/Extensions/ClickHouseEntityTypeExtensions.cs	87.17%	0 Missing and 5 partials ⚠️
...Migrations/Internal/ClickHouseHistoryRepository.cs	80.76%	5 Missing ⚠️
...xtensions/ClickHouseEntityTypeBuilderExtensions.cs	90.90%	3 Missing and 1 partial ⚠️
... and 3 more

📢 Thoughts on this report? Let us know!

Copilot

Pull request overview

Adds EF Core DDL/migrations support for the ClickHouse provider, including engine-specific table DDL, annotation flow through migrations/model differ, design-time services for dotnet-ef, and broad unit/integration/CLI smoke test coverage.

Changes:

Implement ClickHouse-specific migrations SQL generation (CREATE TABLE with ENGINE clauses, ALTER COLUMN removals, skipping indexes, create/drop database ops) and history repository behavior.
Add ClickHouse engine/DDL fluent APIs + conventions (default MergeTree + ORDER BY behavior) and propagate annotations through design-time/migrations.
Add integration and CLI smoke tests (Testcontainers + dotnet-ef) and wire CI to install dotnet-ef.

Reviewed changes

Copilot reviewed 44 out of 44 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
test/EFCore.ClickHouse.Tests/MigrationSqlGeneratorTests.cs	Unit tests for generated migration SQL (engines, expressions, removals, indexes).
test/EFCore.ClickHouse.Tests/MigrationIntegrationTests.cs	Integration tests verifying applied migration effects via ClickHouse system tables.
test/EFCore.ClickHouse.Tests/EnsureCreatedTests.cs	Integration tests for EnsureCreated/EnsureDeleted behavior against ClickHouse.
test/EFCore.ClickHouse.Tests/EngineConfigurationTests.cs	Unit tests for fluent engine configuration annotations and conventions.
test/EFCore.ClickHouse.Tests/EFCore.ClickHouse.Tests.csproj	Adds EFCore.Design dependency for test scenarios.
test/EFCore.ClickHouse.Tests/DotnetEfCliTests.cs	End-to-end `dotnet-ef` CLI smoke tests against a real ClickHouse instance.
test/EFCore.ClickHouse.DesignSmoke/SmokeDbContext.cs	Design-time DbContext + factory used by CLI smoke tests.
test/EFCore.ClickHouse.DesignSmoke/Program.cs	Minimal entry point for `dotnet-ef` discovery.
test/EFCore.ClickHouse.DesignSmoke/EFCore.ClickHouse.DesignSmoke.csproj	Standalone smoke project referencing provider + EFCore.Design.
src/EFCore.ClickHouse/Migrations/Operations/ClickHouseDropDatabaseOperation.cs	New migration operation for dropping databases.
src/EFCore.ClickHouse/Migrations/Operations/ClickHouseCreateDatabaseOperation.cs	New migration operation for creating databases.
src/EFCore.ClickHouse/Migrations/Internal/ClickHouseMigrationsAnnotationProvider.cs	Ensures ClickHouse annotations are carried onto “remove” operations.
src/EFCore.ClickHouse/Migrations/Internal/ClickHouseMigrationDatabaseLock.cs	No-op migrations lock implementation for ClickHouse.
src/EFCore.ClickHouse/Migrations/Internal/ClickHouseHistoryRepository.cs	ClickHouse-specific migrations history table + idempotent-script rejection.
src/EFCore.ClickHouse/Migrations/ClickHouseMigrationsSqlGenerator.cs	Core migration SQL generator implementation for ClickHouse DDL/DML ops.
src/EFCore.ClickHouse/Metadata/Internal/ClickHouseAnnotationProvider.cs	Adds annotation emission from model/table/index/column into relational model.
src/EFCore.ClickHouse/Metadata/Internal/ClickHouseAnnotationNames.cs	Expands annotation constants for engines, settings, columns, and skipping indexes.
src/EFCore.ClickHouse/Metadata/Conventions/ClickHouseDefaultEngineConvention.cs	Sets default MergeTree + default ORDER BY behavior at model finalization.
src/EFCore.ClickHouse/Metadata/Conventions/ClickHouseConventionSetBuilder.cs	Removes FK conventions and adds default engine convention.
src/EFCore.ClickHouse/Metadata/Builders/ClickHouseVersionedCollapsingMergeTreeEngineBuilder.cs	Fluent builder for VersionedCollapsingMergeTree-specific configuration.
src/EFCore.ClickHouse/Metadata/Builders/ClickHouseSummingMergeTreeEngineBuilder.cs	Fluent builder for SummingMergeTree-specific configuration.
src/EFCore.ClickHouse/Metadata/Builders/ClickHouseSimpleEngineBuilder.cs	Fluent builder enforcing restrictions for “simple” engines (Memory/Log/etc.).
src/EFCore.ClickHouse/Metadata/Builders/ClickHouseReplacingMergeTreeEngineBuilder.cs	Fluent builder for ReplacingMergeTree-specific configuration.
src/EFCore.ClickHouse/Metadata/Builders/ClickHouseMergeTreeEngineBuilder.cs	Fluent builder for MergeTree configuration.
src/EFCore.ClickHouse/Metadata/Builders/ClickHouseGraphiteMergeTreeEngineBuilder.cs	Fluent builder for GraphiteMergeTree configuration.
src/EFCore.ClickHouse/Metadata/Builders/ClickHouseEngineBuilder.cs	Base fluent builder implementing shared table options (ORDER BY, TTL, settings, etc.).
src/EFCore.ClickHouse/Metadata/Builders/ClickHouseCollapsingMergeTreeEngineBuilder.cs	Fluent builder for CollapsingMergeTree configuration.
src/EFCore.ClickHouse/Metadata/Builders/ClickHouseAggregatingMergeTreeEngineBuilder.cs	Fluent builder for AggregatingMergeTree configuration.
src/EFCore.ClickHouse/Infrastructure/Internal/ClickHouseModelValidator.cs	Adds engine configuration validation/warnings in model validator.
src/EFCore.ClickHouse/Extensions/ClickHouseServiceCollectionExtensions.cs	Registers migrations services (SQL generator, history repo, annotation provider).
src/EFCore.ClickHouse/Extensions/ClickHousePropertyExtensions.cs	Adds property-level annotation accessors (codec/ttl/comment).
src/EFCore.ClickHouse/Extensions/ClickHousePropertyBuilderExtensions.cs	Adds fluent APIs for property codec/ttl/comment.
src/EFCore.ClickHouse/Extensions/ClickHouseIndexExtensions.cs	Adds index-level annotation accessors for skipping indexes.
src/EFCore.ClickHouse/Extensions/ClickHouseIndexBuilderExtensions.cs	Adds fluent APIs for skipping index type/granularity/params.
src/EFCore.ClickHouse/Extensions/ClickHouseEntityTypeExtensions.cs	Adds entity/table-level annotation accessors (engine, order by, ttl, settings, etc.).
src/EFCore.ClickHouse/Extensions/ClickHouseEntityTypeBuilderExtensions.cs	Adds `ToTable(...).Has*Engine()` fluent entry points.
src/EFCore.ClickHouse/EFCore.ClickHouse.csproj	Adds EFCore.Design reference to runtime package.
src/EFCore.ClickHouse/Design/Internal/ClickHouseDesignTimeServices.cs	Registers design-time services for tooling (`dotnet-ef`).
src/EFCore.ClickHouse/Design/Internal/ClickHouseCodeGenerator.cs	Provider code generator for `UseClickHouse(...)` scaffolding output.
src/EFCore.ClickHouse/Design/Internal/ClickHouseAnnotationCodeGenerator.cs	Ensures ClickHouse-prefixed annotations are not treated as convention-handled.
README.md	Documents engine configuration + migrations support and limitations.
ClickHouse.EntityFrameworkCore.sln	Adds the new DesignSmoke project to the solution.
.github/workflows/tests.yml	Installs `dotnet-ef` in CI before restore/build/test.
.github/workflows/coverage.yml	Installs `dotnet-ef` in CI before coverage run.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

alex-clickhouse · 2026-04-13T12:42:24Z

@codex[agent] review

Copilot

Pull request overview

Copilot reviewed 45 out of 45 changed files in this pull request and generated 14 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-15T15:40:39Z

          dotnet-version: 10.x

+      - name: Install dotnet-ef
+        run: dotnet tool install --global dotnet-ef


The workflow installs dotnet-ef without a version pin. To keep CI deterministic and compatible with the EF Core version referenced by the projects, pin the tool version (e.g., --version 10.0.2 / 10.*).

Suggested change

run: dotnet tool install --global dotnet-ef

run: dotnet tool install --global dotnet-ef --version 10.0.2

add support for migrations

6a86172

alex-clickhouse added 6 commits April 10, 2026 21:37

integration test adjustments

2ec0c81

readme

e9c34bb

test fixes

db4cb0d

test fixes

04be47d

test fixes

833c096

fixes and more tests

6139988

alex-clickhouse force-pushed the migrations branch from 008d912 to 6139988 Compare April 13, 2026 12:03

alex-clickhouse changed the title ~~Add support for migrations~~ Add support for DDL/migrations Apr 13, 2026

alex-clickhouse changed the title ~~Add support for DDL/migrations~~ Add support for DDL generation/migrations Apr 13, 2026

alex-clickhouse requested a review from Copilot April 13, 2026 12:05

Copilot started reviewing on behalf of alex-clickhouse April 13, 2026 12:05 View session

Copilot AI reviewed Apr 13, 2026

View reviewed changes

fixes and tests

ee71b92

Codex started work on behalf of alex-clickhouse April 13, 2026 12:42 View session

Codex finished work on behalf of alex-clickhouse April 13, 2026 12:44

Codex started work on behalf of alex-clickhouse April 13, 2026 12:51 View session

Codex finished work on behalf of alex-clickhouse April 13, 2026 12:54

alex-clickhouse added 3 commits April 15, 2026 16:13

improve table definition validation

d9cfb3c

lambda based engine config overloads

9a12b7b

more table config tests

8d59cfc

alex-clickhouse requested a review from Copilot April 15, 2026 15:33

Copilot started reviewing on behalf of alex-clickhouse April 15, 2026 15:33 View session

Copilot AI reviewed Apr 15, 2026

View reviewed changes

alex-clickhouse added 2 commits April 15, 2026 18:14

fixes

2637615

md file updates

7d1398f

alex-clickhouse merged commit 522b03a into main Apr 15, 2026
3 checks passed

alex-clickhouse deleted the migrations branch April 15, 2026 17:38

	run: dotnet tool install --global dotnet-ef
	run: dotnet tool install --global dotnet-ef --version 10.0.2

Conversation

alex-clickhouse commented Apr 10, 2026

Uh oh!

codecov bot commented Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alex-clickhouse commented Apr 13, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Apr 10, 2026 •

edited

Loading